Developer Documentation

QuickTime 4 API Documentation

QuickTime 4 Reference

| Previous | Chapter Contents | Chapter Top | Next |

SMPTE Iris Effects

kIrisTransitionType ('smp2')

This effect is an implementation of the 26 iris effects from ANSI/SMPTE 258M-1993, plus two Apple-defined wipes that choose a random effect. These are a series of "reveal" type effects that take place between two sources. For full definitions of these 26 iris effects and what they look like, please refer to the SMPTE documentation.

Example:

The SMPTE iris effects take two sources and seven parameters.

Parameters

Use the descriptions below to help you understand what the parameters do. To learn how to use parameter atoms, see "Adding Video Effects to a QuickTime Movie"

Name

Code

QTAtom Type

Description

Percentage

'pcnt'

kParameterTypeDataFixed

Always a tween

This parameter contains a tween. As the effect progresses, QuickTime renders the frame of the effect indicated by the tween's current value, as a percentage of the whole effect. For example, if the tween goes from 0 to 100, the effect renders completely; if the tween goes from 25 to 75, rendering begins 25% into the effect and terminates 75% through the effect.

Wipe ID

'wpID'

kParameterTypeDataEnum

The SMPTE ID for the effect. By setting this parameter, you control which of the 26 available iris effects is used. See the enumeration list below.

Soft border

'soft'

kParameterTypeDataBitField

Can be a tween

If this parameter contains true , the border drawn around the second source is blurred.

Border width

'widt'

kParameterTypeDataFixed

Can be a tween

The width, in pixels, of a border that is drawn around the second source.

Border color

'bclr'

kParameterTypeDataRGBValue

Can be a tween

The RGB color of the border around the second source.

Horizontal repeat

'hori'

kParameterTypeDataLong

Can be a tween

The number of horizontal repeats of the effect that are executed in a single source.

Vertical repeat

'vert'

kParameterTypeDataLong

Can be a tween

The number of vertical repeats of the effect that are executed in a single source.

Wipe ID Enum

The Wipe ID parameter can take the following values:

Value

String

101 Rectangle
102 Diamond
103 Triangle
104 Triangle right
105 Triangle upside down
106 Triangle left
107 Arrowhead
108 Arrowhead right
109 Arrowhead upside down
110 Arrowhead left
111 Pentagon
112 Pentagon upside down
113 Hexagon
114 Hexagon side
119 Circle
120 Oval
121 Oval side
122 Cat eye
123 Cat eye side
124 Round rect
125 Round rect side
127 4 point star
128 5 point star
129 6 point star
130 Heart
131 Keyhole
409 Random effect (One of the 133 SMPTE effects is chosen at random)
502 Random iris (One of the 26 SMPTE iris effects is chosen at random)

© 1999 Apple Computer, Inc.

| Previous | Chapter Contents | Chapter Top | Next |